home *** CD-ROM | disk | FTP | other *** search
/ The World of Computer Software / The World of Computer Software.iso / mg10.zip / MAGCOM.DOC < prev    next >
Text File  |  1993-01-23  |  53KB  |  1,503 lines

  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.  
  15.  
  16.  
  17.  
  18.  
  19.  
  20.  
  21.  
  22.  
  23.  
  24.  
  25.  
  26.  
  27.  
  28.                                        MagCom
  29.  
  30.                                      version 1.0
  31.  
  32.  
  33.  
  34.  
  35.  
  36.                            Concord Software, Jasen M. Fici
  37.  
  38.  
  39.  
  40.  
  41.  
  42.                                     Copyright 1993
  43.  
  44.                                  All Rights Reserved
  45.  
  46.  
  47.                                                                Copyright
  48.  
  49.  
  50.  
  51.  
  52.  
  53.                                       Copyright
  54.  
  55.  
  56.  
  57.             Magcom was written, and is owned  by Concord Software.   All
  58.             programs and documentation distributed with this package are
  59.             protected under  United States  and international  copyright
  60.             laws.  All rights granted by these laws are reserved by  the
  61.             authors Jasen  M.  Fici  and Concord  Software.    Under  no
  62.             circumstances shall any part  of MagCom be redistributed  in
  63.             any way  other than  permitted  in the  distribution  policy
  64.             stated             in             this             document.
  65.  
  66.  
  67.                                                        Table Of Contents
  68.  
  69.  
  70.  
  71.  
  72.  
  73.             Distribution Policy ......................................i
  74.             Warranty .................................................ii
  75.             License Agreement ........................................iii
  76.             Chapter 1 - What is Magcom ? .............................1
  77.             Chapter 2 - Configuration & Set Up .......................3
  78.                  Configuring MAGCOM.CFG ..............................3
  79.                  File Name Conventions ...............................4
  80.                       Magazines ......................................4
  81.                       Publications ...................................4
  82.                  Setting up Magcom to create magazines/publications ..5
  83.                  Setting Up Magcom on a BBS ..........................6
  84.                  Importing New Magazines .............................7
  85.             Chapter 3 - Creating a Magazine or Publication ...........11
  86.                  Creating Magazines - The Script File ................12
  87.                  Script File Commands ................................12
  88.                       Required Commands ..............................13
  89.                       Optional Commands ..............................14
  90.                       The LEVEL command ..............................15
  91.                       Compiling the Script ...........................17
  92.                       Compiling Publications .........................17
  93.             Chapter 4 - Navigating Magview ...........................19
  94.                  Starting Magview ....................................19
  95.                  Viewing Articles ....................................19
  96.                       Viewing the Article ............................20
  97.                       Show Information on Article ....................20
  98.                       Download Article ...............................20
  99.             In Closing ...............................................21
  100.  
  101.  
  102.                                                                 Foreward
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.                                  Distribution Policy
  112.  
  113.  
  114.             This is an evaluation package of MagCom.  MagCom is NOT in
  115.             the public domain, nor is it free software.  Instead, in
  116.             order to make MagCom more use to the public, it is being
  117.             distributed and redistributed as "shareware" under the
  118.             following conditions :
  119.  
  120.                  * MagCom is distributed in its original distribution
  121.                  form.  Do not change, alter or delete in any way the
  122.                  contents of the distribution files.
  123.  
  124.                  * MagCom is not to be distributed with any other
  125.                  software package without prior written consent from the
  126.                  authors.
  127.  
  128.                  * MagCom can not be distributed for any cost exceeding
  129.                  a $10 maximum disk copying charge.
  130.  
  131.                  * MagCom may not be used by any government agency, or
  132.                  affiliated government agency.
  133.  
  134.             Distribution of the REGISTERED version of MagCom in any way,
  135.             shape or form is in direct violation of the law.
  136.  
  137.  
  138.  
  139.  
  140.  
  141.  
  142.  
  143.  
  144.  
  145.  
  146.  
  147.  
  148.  
  149.  
  150.  
  151.  
  152.  
  153.  
  154.  
  155.  
  156.  
  157.  
  158.  
  159.  
  160.                                          -i-
  161.  
  162.  
  163.                                                                 Foreward
  164.  
  165.  
  166.  
  167.  
  168.  
  169.  
  170.  
  171.  
  172.                                       Warranty
  173.  
  174.  
  175.             MagCom is provided "AS  IS"  without  warranty of any  kind.
  176.             The authors  will only  be held  responsible to  the  extent
  177.             permitted under applicable law.  The entire risk is  assumed
  178.             by you.   If  any part  of MagCom  is found  defective,  the
  179.             authors are not liable for anything.
  180.  
  181.             DISCLAIMER :  Concord Software, (and it's respective owners)
  182.             make no representations or  warranties, either expressed  or
  183.             implied,  with   respect   to  the   contents   hereof   and
  184.             specifically disclaims  any warranties,  merchantability  or
  185.             fitness for any particular purpose.  Any software  described
  186.             in this manual  is sold  or licensed  "AS IS."   Should  the
  187.             programs prove  defective  following their  installation  or
  188.             registration (which ever comes first), the user (YOU!), (and
  189.             NOT Concord  Software,  its distributors,  or  its  dealers)
  190.             assumes the entire cost of all necessary servicing,  repair,
  191.             and any incidental or  consequential damages (including  but
  192.             not limited to monetary  damages) resulting from any  defect
  193.             in  the  software.    Further,  Concord  Software  and   its
  194.             respective  owners,  reserves  the  right  to  revise   this
  195.             publication and  make  changes  from time  to  time  in  the
  196.             contents hereof without obligation  to notify any person  of
  197.             such revision or changes.
  198.  
  199.  
  200.  
  201.             Information in this  document is subject  to change  without
  202.             notice and does not  represent a commitment  on the part  of
  203.             Concord Software.
  204.  
  205.  
  206.  
  207.  
  208.  
  209.  
  210.  
  211.  
  212.  
  213.  
  214.  
  215.  
  216.  
  217.  
  218.  
  219.  
  220.  
  221.                                         -ii-
  222.  
  223.  
  224.                                                                 Foreward
  225.  
  226.  
  227.  
  228.  
  229.  
  230.  
  231.  
  232.  
  233.                                   License Agreement
  234.  
  235.  
  236.             MagCom is distributed to the public as an EVALUATION copy
  237.             under the concept of "shareware".  You are hereby granted
  238.             the right to use the evaluation copy for a period of 30 days
  239.             since that day of first using MagCom.  If you wish to
  240.             continue using it after such time, you are required to
  241.             register it with the authors (Concord Software).
  242.  
  243.             If you have any questions or concerns about this policy,
  244.             please feel free to contact the authors.
  245.  
  246.             Registration is a simple process, simply print the enclosed
  247.             file REGISTER.FRM to your printer, fill out
  248.             completely, and mail it with your check or money order made
  249.             out to Concord Software.
  250.  
  251.             You are hereby granted the right to use the registered
  252.             version of MagCom under the condition that only one copy of
  253.             MagCom may be used per registration.  This means that if
  254.             only one registration fee is sent by you, you will receive
  255.             one copy of MagCom to execute on your computer.  At no time
  256.             are you permitted to run multiple copies of your registered
  257.             version.  If you wish to do so, each copy that you wish to
  258.             run must be registered.
  259.  
  260.             Once again, MagCom is NOT free software.  We are not giving
  261.             away free copies.  Instead, we are giving you the chance to
  262.             try it before paying for it.
  263.  
  264.  
  265.  
  266.  
  267.  
  268.  
  269.  
  270.  
  271.  
  272.  
  273.  
  274.  
  275.  
  276.  
  277.  
  278.  
  279.  
  280.  
  281.  
  282.                                         -iii-
  283.  
  284.  
  285.                                                                Chapter 1
  286.  
  287.  
  288.  
  289.  
  290.  
  291.  
  292.  
  293.  
  294.                             Chapter 1 - What is Magcom ?
  295.  
  296.  
  297.             Magcom is a full featured, magazine and publication manager,
  298.             viewer, and on-line door.  It encompasses a rather wide
  299.             range of functions, but is extremely easy to use.
  300.  
  301.             Who is Magcom for?  In a word, EVERYONE!
  302.  
  303.                  For the writers, and people who create publications,
  304.             Magcom is a GREAT magazine management facility.  It allows
  305.             the authors to easily manage individual articles, full
  306.             magazines, and entire publications (multiple issues of the
  307.             same magazine).  It creates compressed archives of magazine
  308.             and publications on command, and allows for the easy
  309.             distribution of such on-line-creations.
  310.  
  311.                  For the sysop, Magcom can be used for a couple
  312.             different things.  First, for the sysop who wants the most
  313.             complete and fully functional news/bulletin creator for
  314.             their BBS, Magcom can not be out done.  Second, almost
  315.             painlessly, on-line magazines and publications created by
  316.             authors who also decide to use Magcom (mentioned above), can
  317.             be viewed, captured, or downloaded by their users.  Magcom
  318.             is the ultimate on-line magazine viewer! (and as far as we
  319.             know, the only one).
  320.  
  321.                  For the casual BBS users, Magcom can make your life
  322.             EXTREMELY easier.  No longer are you required to pan through
  323.             an entire on-line document to get to the part that you want
  324.             to read.  Anything created with Magcom will allow you to
  325.             view things in an orderly and structured fashion.  It even
  326.             allows you to download individual sections of a publication
  327.             with the seven internal protocols supplied!
  328.  
  329.                  Before we get down to the nitty-gritty, we need to get
  330.             our vocabulary straight.  Most of these terms mean just what
  331.             you would think they would mean in the non-computer world,
  332.             but you know how compu-buffs like to make life that much
  333.             harder :
  334.  
  335.             article : An individual text pertaining to a given subject.
  336.             It's composed of words, sentences, and paragraphs.  Within
  337.             Magcom, any individual text file is considered an article.
  338.             All text files should contain no extended character or
  339.             printer codes, and each line should be end with the standard
  340.             line feed and carriage return.  The most common text editor
  341.             for creating such files is probably MS-DOS's EDIT.COM found
  342.  
  343.                                          -1-
  344.  
  345.  
  346.                                                                Chapter 1
  347.  
  348.  
  349.  
  350.  
  351.  
  352.             in v5.0.
  353.  
  354.             magazine : A collection of articles.  Magcom creates
  355.             magazines automatically.  A magazine usually serves a
  356.             particular purpose, or follows a common theme throughout all
  357.             the articles contained in it.
  358.  
  359.             publication : A collection of magazines.  Magcom creates
  360.             publications automatically upon request.
  361.  
  362.  
  363.  
  364.  
  365.  
  366.  
  367.  
  368.  
  369.  
  370.  
  371.  
  372.  
  373.  
  374.  
  375.  
  376.  
  377.  
  378.  
  379.  
  380.  
  381.  
  382.  
  383.  
  384.  
  385.  
  386.  
  387.  
  388.  
  389.  
  390.  
  391.  
  392.  
  393.  
  394.  
  395.  
  396.  
  397.  
  398.  
  399.  
  400.  
  401.  
  402.  
  403.  
  404.                                          -2-
  405.  
  406.  
  407.                                                                Chapter 2
  408.  
  409.  
  410.  
  411.  
  412.  
  413.  
  414.  
  415.  
  416.                          Chapter 2 - Configuration & Set Up
  417.  
  418.  
  419.  
  420.             Configuring MAGCOM.CFG
  421.  
  422.             Magcom uses a single configuration text file.  It is a
  423.             regular ASCII file called MAGCOM.CFG, and contains only 2
  424.             lines of text.  Don't be fooled though, simply because
  425.             Magcom is that simple to set up, don't get the impression it
  426.             isn't extremely powerful.
  427.  
  428.             Magcom contains 2 executable files :  MAGCOM.EXE and
  429.             MAGVIEW.EXE.
  430.  
  431.             Both of them require magcom.cfg to be present in the current
  432.             DOS directory.  NOTE that this does NOT mean that MagCom and
  433.             magview are required to be there also.  As a matter of fact,
  434.             they can be located anywhere in your current DOS path.
  435.  
  436.             Line one (1) of MAGCOM.CFG must contain a path to a
  437.             temporary directory set up exclusively for Magcom.  It is
  438.             essential that this does NOT point to any directories where
  439.             ANY of your other data is contained, and it must not be the
  440.             location of this program or configuration file.  Magcom
  441.             ERASES the entire contents of this directory many times
  442.             throughout its execution, and is simply used as a work
  443.             directory for extracting and compiling data.
  444.  
  445.                  GOOD EXAMPLE :      C:\TEMP\
  446.                  BAD EXAMPLE :       C:\DOS
  447.  
  448.             Get the point!
  449.  
  450.             Line two (2) of MAGCOM.CFG should contain either the word
  451.             "yes" or "no" (excluding the quotation marks).  If you are
  452.             running a bulletin board system, and you wish to allow your
  453.             users to be able to download magazines, or individual
  454.             articles, this line should be set to yes.  If you do not
  455.             wish to give your users the ability for these file
  456.             transfers, this line should be set to no.
  457.  
  458.             Magcom comes with seven (7) internal protocols all set up
  459.             and ready to go, so there is no need for you to worry about
  460.             any of the details of file transfers.
  461.  
  462.             Here is an example MAGCOM.CFG file, just in case you are not
  463.             sure about all of this :
  464.  
  465.                                          -3-
  466.  
  467.  
  468.                                                                Chapter 2
  469.  
  470.  
  471.  
  472.  
  473.  
  474.             C:\TEMP\
  475.             yes
  476.  
  477.             That's all there is to it!
  478.  
  479.  
  480.             File Name Conventions
  481.  
  482.             Finally, before we get into more detail, the naming
  483.             convention that Magcom and Magview use for magazines and
  484.             publications should be explained.
  485.  
  486.                Magazines
  487.  
  488.                  All magazines are named after their volume and issue
  489.                  number in the following way :
  490.  
  491.                       VxxxIyyy.MAG
  492.  
  493.                  xxx represents the volume number of that magazine, and
  494.                  yyy represents the issue number.  Both of them are
  495.                  padded to the left with zeros (0).  For example, issue
  496.                  6, volume 12 a specific magazine would be named :
  497.  
  498.                       V012I006.MAG
  499.  
  500.                Publications
  501.  
  502.                  All publications are named after the first 8 characters
  503.                  of the magazine name.  The magazine name is defined by
  504.                  the authors of the magazine in the script file that
  505.                  they create.  Magcom creates publications (multiple
  506.                  issues of a magazine) by looking at the magazine name
  507.                  of each magazine and compiling them into 1 MAGNAME.PUB
  508.                  file.
  509.  
  510.  
  511.  
  512.  
  513.  
  514.  
  515.  
  516.  
  517.  
  518.  
  519.  
  520.  
  521.  
  522.  
  523.  
  524.  
  525.  
  526.                                          -4-
  527.  
  528.  
  529.                                                                Chapter 2
  530.  
  531.  
  532.  
  533.  
  534.  
  535.  
  536.             Setting up Magcom to create magazines/publications
  537.  
  538.             There are only 2 extra rules that people who wish to use
  539.             Magcom as a magazine/publication creation program need to
  540.             know about :
  541.  
  542.             First, you should ALWAYS maintain a separate directory for
  543.             each different publication you wish to produce.  It is also
  544.             a lot easier if you create yet another directory for you to
  545.             do your work on each magazine issue for your publication.
  546.  
  547.                  For example, lets say you are the author of an on-line
  548.                  publication called "BROOM'S TODAY".  You would first
  549.                  want to make a directory for all your publications, say
  550.                  C:\BROOM.
  551.  
  552.                  Now from there, to keep everything completely
  553.                  organized, we suggest you place 3 sub-directories
  554.                  directly under this one :
  555.  
  556.                  C:\BROOM\MAGS
  557.                  C:\BROOM\CURRENT
  558.                  C:\BROOM\TEMP
  559.  
  560.                  All of your magazine editing sessions would be held in
  561.                  the CURRENT directory, where a copy of your MAGOM.CFG
  562.                  should be held, and the first line of it should point
  563.                  to the C:\BROOM\TEMP directory.
  564.  
  565.                  All compiled magazines or publications could then be
  566.                  held separately in the C:\BROOM\MAGS directory.  It
  567.                  should be noted that if you do not need to create
  568.                  publications, you will not have to have another copy of
  569.                  the magcom.cfg file in this directory, but if you do,
  570.                  you will need to have another copy located there.  This
  571.                  will all be explained later in the Creating Magazines
  572.                  and Publications section.
  573.  
  574.  
  575.  
  576.  
  577.  
  578.  
  579.  
  580.  
  581.  
  582.  
  583.  
  584.  
  585.  
  586.  
  587.                                          -5-
  588.  
  589.  
  590.                                                                Chapter 2
  591.  
  592.  
  593.  
  594.  
  595.  
  596.  
  597.             Setting Up Magcom on a BBS
  598.  
  599.             If you are a sysop who wants to set up Magcom on your system
  600.             so that users may view on-line magazines that you receive,
  601.             there are a few simple rules and configuration settings you
  602.             need to be aware of.
  603.  
  604.             First of all, you will want to create a single directory
  605.             where all of your magazines and publications will be stored.
  606.             You can also keep your MAGVIEW.EXE and MAGCOM.CFG files in
  607.             this directory.  It will probably make things a little
  608.             easier if you do.
  609.  
  610.             Magcom can be set up to operate just like any other BBS
  611.             "door" or on-line game for your system.  It doesn't even
  612.             need any of the standard drop files required by most of
  613.             these type of programs.
  614.  
  615.             To allow users to view all of the on-line magazines that you
  616.             have, simply have your BBS program shell out to a batch file
  617.             and send the following information :
  618.  
  619.                  COMMUNICATIONS PORT USED BY MODEM
  620.                  BAUD RATE
  621.                  LOCKED BAUD RATE
  622.                  TIME LIMIT
  623.  
  624.             Simply set up your batch file to change to the directory
  625.             that all of you magazines/publications are contained (don't
  626.             forget the magcom.cfg either), and run MAGVIEW with command
  627.             line switches to let it know the status of the above 4
  628.             settings.
  629.  
  630.             Of the 4 above parameters that can be sent to Magview, only
  631.             the first 2 (communications port and baud rate) are actually
  632.             required, the others are optional.
  633.  
  634.             The format for executing Magview is as follows :
  635.  
  636.                  MAGVIEW -p{port_number} -b{baud_rate} -o{locked_baud}
  637.                          -t{minutes_left}
  638.  
  639.             If you BBS program executes door files by passing these
  640.             parameters to the batch file in the form of parameters (used
  641.             in your batch files as %1 %2 %3 etc. etc.), this is the
  642.             simplest way to operate Magview.
  643.  
  644.             Magview also supports 3 other command line switches :
  645.  
  646.                  MAGVIEW -l
  647.  
  648.                                          -6-
  649.  
  650.  
  651.                                                                Chapter 2
  652.  
  653.  
  654.  
  655.  
  656.  
  657.                  Executes magview in local mode.  This command will tell
  658.                  magview not to initialize the communications port, and
  659.                  will not check for carrier detection.  This is so the
  660.                  sysop can use Magview
  661.  
  662.                  MAGVIEW -f{file_name.ext}
  663.                  Executes magview and automatically views a magazine or
  664.                  publication.  If this command line is not found,
  665.                  Magview simply looks in to the current directory for
  666.                  all .PUB (publications) and .MAG (magazines) and gives
  667.                  the users a couple of pre-menus which allows them to
  668.                  choose which magazine or publication they wish to look
  669.                  at.  Pretty easy huh?
  670.  
  671.                  MAGVIEW -d{path_&_file_name}
  672.                  Executes magview and tells it to look for the standard
  673.                  DOOR.SYS dropfile supported by many BBS programs.  If
  674.                  this command line is given, there is no need to send
  675.                  any of the 4 required parameters to get magview to work
  676.                  correctly with a user.  Magview will automatically load
  677.                  this file and get all the information it needs.
  678.  
  679.                  This is the preferred method of using Magview, since
  680.                  Magview will then be able to determine other things
  681.                  than just baud rate and time limit.  It will also be
  682.                  able to determine if the user on-line has graphics
  683.                  capabilities, and the screen size of the user on-line.
  684.  
  685.  
  686.             Importing New Magazines
  687.  
  688.                  Since all magazines for a specific publication can be
  689.                  compiled into a single .PUB publication file with
  690.                  MagCom, there is no need for different directories for
  691.                  each different publication that the sysop may be
  692.                  receiving.  The sysop can simply tell MagCom to add any
  693.                  incoming magazines to that particular publication with
  694.                  a little batch file trickery.  This can look a little
  695.                  hairy at first, so make sure you read this over a
  696.                  couple times before you set yourself up for this.
  697.  
  698.                  Assuming you have the following set up :
  699.  
  700.                  You are a sysop and receive 3 different on-line
  701.                  magazine publications, which we will call MAG1, MAG2,
  702.                  and MAG3.  You keep all of these publications in the
  703.                  directory named C:\MAGS
  704.  
  705.                  You also have your MAGCOM.CFG file in this directory,
  706.                  and it reads like this :
  707.  
  708.  
  709.                                          -7-
  710.  
  711.  
  712.                                                                Chapter 2
  713.  
  714.  
  715.  
  716.  
  717.  
  718.                       C:\TEMP\
  719.                       YES
  720.  
  721.                  So, in your c:\mags directory, the following files
  722.                  would now be found :
  723.  
  724.                       magview.exe
  725.                       magcom.exe
  726.                       magcom.cfg
  727.                       mag1.pub
  728.                       mag2.pub
  729.                       mag3.pub
  730.  
  731.                  Simply running MAGVIEW will give you or the user on-
  732.                  line a menu showing all 3 publications and letting them
  733.                  choose which one they want to look at, but more about
  734.                  that later.  Anyway, if you receive a new issue of
  735.                  mag2, you would want to take the following steps to
  736.                  automatically add it to your mag2.pub file :
  737.  
  738.                  1) create a DIFFERENT temporary directory other than
  739.                  that pointed to in your magcom.cfg.  For this example,
  740.                  lets call it c:\t2
  741.  
  742.                       MD C:\T2
  743.  
  744.                  2) change to that directory
  745.  
  746.                       C:
  747.                       CD\T2
  748.  
  749.                  3) copy the magcom.cfg from your magazine directory
  750.                  into this temporary directory
  751.  
  752.                       COPY C:\MAGS\MAGCOM.CFG C:\T2
  753.  
  754.                  4) If MAGCOM.EXE is not in your path, you will have to
  755.                  copy it to this directory also
  756.  
  757.                       COPY C:\MAGS\MAGCOM.EXE C:\T2
  758.  
  759.                  5) Expand your MAG2.PUB file into the T2 directory.
  760.                  Magcom uses a compression method that is compatible
  761.                  with the popular LZH or LHA compression programs.  The
  762.                  programs can be found all over BBS systems, and will be
  763.                  required for this step.
  764.  
  765.  
  766.  
  767.  
  768.  
  769.  
  770.                                          -8-
  771.  
  772.  
  773.                                                                Chapter 2
  774.  
  775.  
  776.  
  777.  
  778.  
  779.  
  780.  
  781.                  IMPORTANT NOTE : You should NOT use these 3rd party
  782.                  compression programs for ANYTHING other than what is
  783.                  being described here.  Magcom uses a slightly + format
  784.                  that these programs can decompress fine, but NOT
  785.                  compress.
  786.  
  787.  
  788.  
  789.  
  790.  
  791.                  The only files you need from the MAG2.PUB are the ones
  792.                  that end in the .MAG extention, so the following
  793.                  command should be executed :
  794.  
  795.                       LHA X C:\MAGS\MAG2.PUB *.MAG C:\T2\
  796.  
  797.                  It should be entered in the exact format used above
  798.                  (unless you are using different directory names of
  799.                  course).  Please note the trailing backslash on the
  800.                  last parameter.  It is essential that it be included,
  801.                  otherwise the magazines will not be extracted properly
  802.                  (actually, they won't be extracted at all!)
  803.  
  804.                  6) Now we want to add our newest issue of the
  805.                  publication to the directory.  This example will assume
  806.                  that the new issue is being stored in a directory
  807.                  called C:\INBOUND.  If you are receiving files VIA some
  808.                  kind of communications network, the magazines will
  809.                  probably be sent to your inbound file directory set up
  810.                  by your network mailer.
  811.  
  812.                       COPY C:\INBOUND\{new_mag}.MAG c:\T2
  813.  
  814.                  For {new_mag} you can use DOS wildcards (probably *.*)
  815.                  to simply copy all the magazines in your inbound
  816.                  directory to our working directory.
  817.  
  818.                  7) Ok, now all magazines are currently stored in the T2
  819.                  directory.  Now, simply run MAGCOM CP {destination_dir}
  820.  
  821.                  This will compile all of the magazines into a single
  822.                  publication.  If {destination_dir} is omitted, as we
  823.                  will assume, Magcom will put the new .PUB into the
  824.                  current directory.  For this example, it is c:\t2
  825.  
  826.                  8) Now, simply erase the old .PUB in the C:\MAGS
  827.                  directory, and copy the new one into it
  828.  
  829.                       ERASE C:\MAGS\MAG2.PUB
  830.  
  831.                                          -9-
  832.  
  833.  
  834.                                                                Chapter 2
  835.  
  836.  
  837.  
  838.  
  839.  
  840.                       COPY *.PUB C:\MAGS
  841.  
  842.                  9) Get rid of all our temporary stuff
  843.  
  844.                       CD \MAGS
  845.                       ERASE \T2\*.MAG
  846.                       ERASE \T2\*.PUB
  847.                       ERASE \T2\*.EXE
  848.                       ERASE \T2\*.CFG
  849.                       RD \T2
  850.  
  851.             There you have it.  A little complicated, and a little
  852.             thinking involved, so here's the batch file again in it's
  853.             entire form :
  854.  
  855.                       MD C:\T2
  856.                       C:
  857.                       CD\T2
  858.                       COPY C:\MAGS\MAGCOM.CFG C:\T2
  859.                       COPY C:\MAGS\MAGCOM.EXE C:\T2
  860.                       LHA X C:\MAGS\MAG2.PUB *.MAG C:\T2\
  861.                       COPY C:\INBOUND\{new_mag}.MAG c:\T2
  862.                       MAGCOM CP {destination_dir}
  863.                       ERASE C:\MAGS\MAG2.PUB
  864.                       COPY *.PUB C:\MAGS
  865.                       CD \MAGS
  866.                       ERASE \T2\*.MAG
  867.                       ERASE \T2\*.PUB
  868.                       ERASE \T2\*.EXE
  869.                       ERASE \T2\*.CFG
  870.                       RD \T2
  871.  
  872.             Well now, it doesn't look that bad anymore does it?
  873.  
  874.             There is an alternate way of doing this.  If you want to
  875.             keep magazines in their own private directories, with their
  876.             own magcom.cfg file, and keep them all in their distribution
  877.             form (most likely, the .MAG form).  You would simply set up
  878.             different doors in your BBS for each magazine.  This way,
  879.             whenever you received a new magazine, you would simply throw
  880.             it into its directory.  Magcom would take care of the rest.
  881.  
  882.             Since having a .PUB file instead of the multiple .MAG files
  883.             does not really save any space (both are compiled and
  884.             compressed), the second way is MUCH easier to set up and
  885.             maintain.  Just remember, that you will have to have a
  886.             magcom.cfg file in each magazine directory, and access to
  887.             the magview.exe from each one.
  888.  
  889.  
  890.  
  891.  
  892.                                         -10-
  893.  
  894.  
  895.                                                              Chapter 3
  896.  
  897.  
  898.  
  899.  
  900.  
  901.  
  902.  
  903.  
  904.                    Chapter 3 - Creating a Magazine or Publication
  905.  
  906.  
  907.                 If you are a NOT going to be using Magcom to create
  908.                magazines or publications (i.e. you are a system
  909.                operator who simply wants to put some magazines on-line
  910.                for your users), you can skip over this chapter.  BUT
  911.                if you want a better understanding of how Magcom
  912.                operates, we suggest that you read through it anyway!
  913.  
  914.                The program MAGCOM.EXE is used to create magazines and
  915.                publications.  Magcom does its magic by compiling a
  916.                script file that the author creates.  To many people,
  917.                this can be a big turn off, but rest assured, there is
  918.                no programming experience required to create these
  919.                simple files needed to create a magazine.
  920.  
  921.                Magcom can operate in one of two modes :
  922.  
  923.                     Compile Magazine : Reads a MagCom script file,
  924.                     compiles all the information and all the files
  925.                     needed to create a magazine, and creates a
  926.                     vXXXiYYY.mag file.  This file is already
  927.                     compressed and ready to be transmitted across
  928.                     telecommunications lines.
  929.  
  930.                     IMPORTANT : You should never change the name of a
  931.                     magazine created by Magcom.  If you do, you will
  932.                     not be able to create a publication which is
  933.                     actually just a set of magazines (with some extra
  934.                     information) set into a single file.
  935.  
  936.                     Compile Publication : Scans through all of the
  937.                     .MAG files in the current directory, and compiles
  938.                     all related ones (i.e. with the same title) into a
  939.                     single MAGNAME.PUB file.
  940.  
  941.                     Again, although it is not required that the name
  942.                     of this file remain the same, if it is (especially
  943.                     the .PUB extention), Magcom will not be able to
  944.                     recognize it as easily as if you leave it alone.
  945.  
  946.  
  947.  
  948.  
  949.  
  950.  
  951.  
  952.  
  953.                                         -11-
  954.  
  955.  
  956.                                                              Chapter 3
  957.  
  958.  
  959.  
  960.  
  961.  
  962.  
  963.                Creating Magazines - The Script File
  964.  
  965.                The heart of the creation of magazines is the script
  966.                file that you create.  This file contains all of the
  967.                information MagCom needs to create a magazine.
  968.  
  969.                To compile a script file, the following command should
  970.                be used :
  971.  
  972.                     MAGCOM CM {script.ext} {destination directory}
  973.  
  974.                {script.ext} is the directory and file name of the
  975.                script file to compile.
  976.  
  977.                {destination directory} is the directory that MagCom
  978.                will place the finished product.  If this option is not
  979.                supplied, MagCom places the compiled magazine in the
  980.                current directory.
  981.  
  982.                The default extention for all script files is .SCR.  If
  983.                you decide to use this extension, you will not have to
  984.                add it to the command line of MagCom every time.  For
  985.                example, if your script's file name is MYSCRIPT.TXT,
  986.                then you will have to execute MagCom like this :
  987.  
  988.                     MAGCOM CM MYSCRIPT.TXT
  989.  
  990.                But if your scripts file name is MYSCRIPT.SCR, you
  991.                would simply have to enter :
  992.  
  993.                     MAGCOM CM MYSCRIPT
  994.  
  995.  
  996.  
  997.                Script files are simple text files that you create.
  998.                They should contain no control codes, and no special
  999.                formatting.  Use a text editor that allows files to be
  1000.                saved this way.  One of the most popular, and best
  1001.                known, is the editor that comes with MS-DOS called
  1002.                (simply enough) EDIT.COM
  1003.  
  1004.  
  1005.  
  1006.  
  1007.  
  1008.  
  1009.                Script File Commands
  1010.  
  1011.                Each text line in a script file can be indented (for
  1012.                clarity reasons).  Magcom will ignore all "white
  1013.  
  1014.                                         -12-
  1015.  
  1016.  
  1017.                                                              Chapter 3
  1018.  
  1019.  
  1020.  
  1021.  
  1022.  
  1023.                space".
  1024.  
  1025.                All text lines that begin with a semi-colon (;) will be
  1026.                ignored by MagCom.  This is provided for commenting
  1027.                reasons.
  1028.  
  1029.                All available commands within MagCom must be the first
  1030.                word on that line of text.  All commands must also be
  1031.                on their separate text line.  This is required for
  1032.                clarity and easier processing.
  1033.  
  1034.  
  1035.  
  1036.                A special note on file names :  Through out a script
  1037.                file, many different file names will need to be
  1038.                included as you will soon find out.  The file does NOT
  1039.                have to be located in the current directory.  You may
  1040.                specify the location & file name required for that
  1041.                specific command.  For example, the INTRODUCTION
  1042.                command can be used in the following manner :
  1043.  
  1044.                     introduction c:\art\intro.ans c:\art\intro.asc
  1045.  
  1046.                Magcom automatically imports the file into the
  1047.                magazine.
  1048.  
  1049.  
  1050.  
  1051.  
  1052.  
  1053.                  Required Commands
  1054.  
  1055.                     Each script file MUST contain the following
  1056.                     commands.  These commands are required for the
  1057.                     successful compilation of a magazine :
  1058.  
  1059.                     date {date of magazine}
  1060.                     The issue date of the magazine.  The date should
  1061.                     be entered in the following format :
  1062.  
  1063.                          Month Date, Year
  1064.  
  1065.                     Month should be completely spelled out.  For
  1066.                     example : November.  Abbreviations are not to be
  1067.                     used.  Date is the day of that month (i.e. 1-31).
  1068.                     Year is the full 4-digit year (i.e. 1993)
  1069.  
  1070.                     title "{magazine name}"
  1071.                     Title of the magazine.  The title must be enclosed
  1072.                     in double quotes (").  If you are going to be
  1073.                     publishing multiple issues and volumes of a
  1074.  
  1075.                                         -13-
  1076.  
  1077.  
  1078.                                                              Chapter 3
  1079.  
  1080.  
  1081.  
  1082.  
  1083.  
  1084.                     magazine, you must make sure that the magazine
  1085.                     name is the same for all issues.  Doing this
  1086.                     allows MagCom to properly compile publications.
  1087.                     If you do not plan on creating publications for
  1088.                     you magazine, you should still use the same name
  1089.                     here, because people who receive your magazine may
  1090.                     like to keep all issues of your magazine compiled
  1091.                     into a publication.  They won't be able to do this
  1092.                     if you name the magazine different every time.
  1093.  
  1094.                     volume {volume number}
  1095.                     Volume number of the magazine.  {volume number}
  1096.                     should simply be a number identifying the volume
  1097.                     number.  If you are creating a 1 time magazine,
  1098.                     and won't be releasing subsequent ones, a 0 should
  1099.                     be used here.
  1100.  
  1101.                     issue {issue number}
  1102.                     Issue number of the magazine.  {issue number}
  1103.                     should simply be a number identifying the issue
  1104.                     number.  If you are creating a 1 time magazine,
  1105.                     and won't be releasing subsequent ones, a 0 here
  1106.                     should also be used.
  1107.  
  1108.                     theme "{theme of magazine}"
  1109.                     The theme of the current magazine.  The theme of
  1110.                     the magazine is displayed when multiple issues of
  1111.                     a magazine, or publications are shown.  This
  1112.                     allows people who are using magview to get a quick
  1113.                     description of this magazine.  {theme of magazine}
  1114.                     should not exceed 40 characters in length.
  1115.  
  1116.                  Optional Commands
  1117.  
  1118.                     The following commands are available, but not
  1119.                     required in your script :
  1120.  
  1121.                     introduction {ANSI file name} {ASCII file name}
  1122.                     The ANSI and ASCII file names that magview will
  1123.                     show immediately when a user decides to view this
  1124.                     magazine.  The user has no choice and is forced to
  1125.                     view this file.  If the user has ANSI
  1126.                     capabilities, the {ANSI} file will be displayed.
  1127.                     If they do not, the {ASCII} file will be
  1128.                     displayed.
  1129.  
  1130.                     If you use this command, BOTH the ANSI and ASCII
  1131.                     file names must be specified.  If you do not wish
  1132.                     to make one of the files, then the keyword NONE
  1133.                     should be used in its place.  For example,
  1134.                     INTRODUCTION NONE HELLO.ASC would show an
  1135.  
  1136.                                         -14-
  1137.  
  1138.  
  1139.                                                              Chapter 3
  1140.  
  1141.  
  1142.  
  1143.  
  1144.  
  1145.                     introduction file to users with ASCII capabilities
  1146.                     only.  Users with ANSI would be brought directly
  1147.                     to the article menu.
  1148.  
  1149.                     leaving {ANSI file name} {ASCII file name}
  1150.                     The ANSI and ASCII file names that magview will
  1151.                     show immediately when a user decides to quit this
  1152.                     magazine.  The user has no choice and is forced to
  1153.                     view this file.  If the user has ANSI
  1154.                     capabilities, the {ANSI} file will be displayed.
  1155.                     If they do not, the {ASCII} file will be
  1156.                     displayed.
  1157.  
  1158.                     If you use this command, BOTH the ANSI and ASCII
  1159.                     file names must be specified.  If you do not wish
  1160.                     to make one of the files, then the keyword NONE
  1161.                     should be used in its place.  For example, LEAVING
  1162.                     NONE GOODBYE.ASC would show an introduction file
  1163.                     to users with ASCII capabilities only.  Users with
  1164.                     ANSI would be brought directly to the article
  1165.                     menu.
  1166.  
  1167.                  The LEVEL command
  1168.  
  1169.                     The level command is the main part of a script
  1170.                     file.  It can best be explained by showing a quick
  1171.                     example :
  1172.  
  1173.    level 1 "Editorials"
  1174.     level 2 "Jasen's editorial" jasen.txt author "Jasen Fici" menu editor.mnu
  1175.     level 2 "Joey's editorial" joey.txt author "Joe"
  1176.    level 1 "Movie Review" movie.txt
  1177.                     
  1178.                          
  1179.  
  1180.                     (notice the indentation for clarity only!)  Pretty
  1181.                     tough huh?  That's all there is to it.  Each level
  1182.                     defines one of two things :
  1183.  
  1184.                          a) A sub-heading to more menus
  1185.                          b) An actual article to be viewed
  1186.  
  1187.                     Here is the format of a level command :
  1188.  
  1189.                     level {level number} "{title} [{file name of 
  1190.                          article}[author {author's name}] [menu {menu 
  1191.                            file name}]]
  1192.  
  1193.                     {level number} describes the current level that
  1194.                     this text is to be placed under.  Notice the
  1195.                     numbering must be structured.
  1196.  
  1197.                                         -15-
  1198.  
  1199.  
  1200.                                                              Chapter 3
  1201.  
  1202.  
  1203.  
  1204.  
  1205.  
  1206.                     Here are the rules and explanations for all level
  1207.                     commands :
  1208.  
  1209.                     1) All level numbers must be between 1 and 30.
  1210.  
  1211.                     2) The first level command in your script file
  1212.                     MUST be a level 1
  1213.  
  1214.                     3) If there is nothing present immediately after
  1215.                     the "title", MagCom assumes that it is a
  1216.                     subheading to another level.  Therefore, the next
  1217.                     level MUST be incremented by 1.
  1218.  
  1219.                     4) If the file name is present after the "{title}"
  1220.                     section, MagCom looks for the existence of the
  1221.                     file and adds it to the magazine.
  1222.  
  1223.                     5) If the keyword AUTHOR is found after the file
  1224.                     name of the article, MagCom will take the name in
  1225.                     double quotes immediately following the AUTHOR
  1226.                     keyword, and place it in the magazine.  This
  1227.                     keyword is NOT required.
  1228.  
  1229.                     6) If the keyword MENU is found after the file
  1230.                     name of the article, MagCom will look for the
  1231.                     {menu file name} and add it to the magazine.  This
  1232.                     file will be displayed in place of the generic
  1233.                     article listing usually shown.  If you use this
  1234.                     command to create your own personalized menus for
  1235.                     your magazine, it MUST be only contained on the
  1236.                     FIRST LEVEL COMMAND of that section.
  1237.  
  1238.                     In our quick example shown above, the menu command
  1239.                     is on the first level 2 command.  When this
  1240.                     magazine is first shown, the user is shown the
  1241.                     generic listing of:
  1242.  
  1243.                          Editorials ..........    1
  1244.                          Movie Review.........    2
  1245.  
  1246.                     If the user chooses 1 for Editorials, Magview
  1247.                     would usually show the next level menu :
  1248.  
  1249.                          Jasen's editorial....    1
  1250.                          Joey's editorial.....    2
  1251.  
  1252.                     BUT since the MENU command was given on the
  1253.                     Jasen's editorial level command, the alternate
  1254.                     EDITOR.MNU text menu will be shown.  Get it?
  1255.  
  1256.                     For an example of how this all fits together, take
  1257.  
  1258.                                         -16-
  1259.  
  1260.  
  1261.                                                              Chapter 3
  1262.  
  1263.  
  1264.  
  1265.  
  1266.  
  1267.                     a look at the EXAMPLE.SCR file and the .MAG file
  1268.                     included with Magcom.
  1269.  
  1270.                     Once you get the hang of creating these script
  1271.                     files (believe us, it won't take long!), you will
  1272.                     be creating magazines in no time flat.
  1273.  
  1274.                  Compiling the Script
  1275.  
  1276.                     Once again, to compile the script file you have
  1277.                     created, use the following command :
  1278.  
  1279.                     MAGCOM CM {script file name} [{destination 
  1280.                          directory}]
  1281.  
  1282.                     Magcom will begin compiling the script file.  If
  1283.                     any errors are encountered, MagCom will abort
  1284.                     processing and give you a one line description of
  1285.                     what went wrong.
  1286.  
  1287.                     Once Magcom has successfully compiled your
  1288.                     magazine script, it will then try to create your
  1289.                     magazine.  If a magazine with the same name
  1290.                     already exists in the destination directory,
  1291.                     Magcom will warn you and ask if you want to
  1292.                     overwrite it.  BE CAREFUL!  Since magazine names
  1293.                     are generic, you have to make sure you are not
  1294.                     overwriting a different magazine!
  1295.  
  1296.                  Compiling Publications
  1297.  
  1298.                     To compile a publication, simply place all .MAG
  1299.                     files of the same magazine and run:
  1300.  
  1301.                          MAGCOM CP [{destination directory}]
  1302.  
  1303.                     Magcom will then collect all magazine issues, and
  1304.                     create your .PUB file in the destination
  1305.                     directory.  If the destination directory is not
  1306.                     given, it will place the publication in the
  1307.                     current directory.
  1308.  
  1309.  
  1310.  
  1311.  
  1312.  
  1313.  
  1314.  
  1315.  
  1316.  
  1317.  
  1318.  
  1319.                                         -17-
  1320.  
  1321.  
  1322.                                                                Chapter 4
  1323.  
  1324.  
  1325.  
  1326.  
  1327.  
  1328.  
  1329.  
  1330.  
  1331.                            Chapter 4 - Navigating Magview
  1332.  
  1333.  
  1334.             For both the system operator, or the user, Magview is about
  1335.             as straight forward as it can get.  Use the procedures
  1336.             mentioned in chapter 2 for starting Magview.
  1337.  
  1338.  
  1339.             Starting Magview
  1340.  
  1341.             If no magazine or publication name if given with the -f
  1342.             command line parameter, Magview will search the current
  1343.             directory for all .MAG and .PUB files.  Once they have all
  1344.             been located, magview will show all magazines and
  1345.             publications found.  The user can then choose which magazine
  1346.             or publication they wish to view.
  1347.  
  1348.             If a publication was given with the -f command line
  1349.             parameter, or the user has chosen to view a publication via
  1350.             the menu described above, Magview will look inside the
  1351.             publication and show a menu of all available magazines
  1352.             within that publication.  The user can then choose which
  1353.             magazine they wish to view.
  1354.  
  1355.  
  1356.             Viewing Articles
  1357.  
  1358.             Once a magazine has been chosen, Magview simply shows lists
  1359.             of all available articles (or subheadings to another list of
  1360.             articles), and allows the user to choose which one they wish
  1361.             to use.
  1362.  
  1363.             If magview has NOT been initiated in local mode (i.e. a user
  1364.             is on-line), and magcom.cfg allows for user downloads, and
  1365.             extra option [D] will be allowed from the magazine menu.  If
  1366.             a user chooses this option, they will be allowed to download
  1367.             the entire magazine with one of the 7 protocols supplied my
  1368.             magview.  Once this user has decided that they wish to
  1369.             download the magazine, magview compiles all the text
  1370.             (including introduction and leaving files) into a single
  1371.             text file.  The user is then prompted as to which protocol
  1372.             they wish to use, and magview lets them download it.
  1373.  
  1374.             If a user has chosen to view an article, magview first asks
  1375.             the user whether they want to :
  1376.  
  1377.                  1) View the article
  1378.                  2) Show information on the article
  1379.  
  1380.                                         -19-
  1381.  
  1382.  
  1383.                                                                Chapter 4
  1384.  
  1385.  
  1386.  
  1387.  
  1388.  
  1389.                  3) If magcom.cfg allows, download this individual
  1390.                     article
  1391.  
  1392.                Viewing the Article
  1393.  
  1394.                  If the user chooses to view the article, it will simply
  1395.                  be displayed on the screen and over the phone (of
  1396.                  course).  Once the user has reached the end of the
  1397.                  file,  the user will again be given the option to
  1398.                  download the article, or return to the article
  1399.                  listings.
  1400.  
  1401.                Show Information on Article
  1402.  
  1403.                  If the user chooses to view the information about the
  1404.                  article, magview will tell the user the date that the
  1405.                  article was written, the author (if known), and the
  1406.                  title.  They will then be brought back to the previous
  1407.                  prompt.
  1408.  
  1409.                Download Article
  1410.  
  1411.                  If the user chooses to download the article, magview
  1412.                  simply prompts the user which protocol they wish to
  1413.                  use, and send the user the uncompressed text of that
  1414.                  particular article.
  1415.  
  1416.  
  1417.  
  1418.  
  1419.  
  1420.  
  1421.  
  1422.  
  1423.  
  1424.  
  1425.  
  1426.  
  1427.  
  1428.  
  1429.  
  1430.  
  1431.  
  1432.  
  1433.  
  1434.  
  1435.  
  1436.  
  1437.  
  1438.  
  1439.  
  1440.  
  1441.                                         -20-
  1442.  
  1443.  
  1444.                                                                   Chapter 4
  1445.  
  1446.  
  1447.  
  1448.  
  1449.  
  1450.  
  1451.  
  1452.  
  1453.                                      In Closing
  1454.  
  1455.  
  1456.           Magcom and Magview are a result of years of on-line experience.
  1457.           Many, Many great publications are transmitted electronically in
  1458.           or as a single text file.  Although many system operators make
  1459.           these magazines available for users to look at while they are on
  1460.           their system, and some even make them available for download,
  1461.           until this time, there has been no easy way for the user to do
  1462.           this (or the sysop to set it up).
  1463.  
  1464.           How can Magcom become successful?  By you, the system operators
  1465.           and users.  If you would like to see your favorite on-line
  1466.           magazines distributed in the MagCom format, you MUST pressure the
  1467.           authors of these magazines to take a look at MagCom.  Don't
  1468.           harass, but make a simple suggestion.  If enough people make the
  1469.           request, eventually they will see the possibilities of Magcom.
  1470.  
  1471.           The number one objection you will here from authors, is that
  1472.           magazines distributed in this format would not allow for users of
  1473.           non-based DOS machines to view it.  Magcom does NOT have to be a
  1474.           switch of the way their magazines are distributed, but simply an
  1475.           addition.  With the thousands of DOS based BBS systems available,
  1476.           distributing magazines in the MagCom format makes nothing but
  1477.           sense.
  1478.  
  1479.           Concord Software would like to thank the following people and
  1480.           companies for their part in Magcom :
  1481.  
  1482.                * TurboPower for their wonderful Async Professional
  1483.                  communications library
  1484.                * Bob Ainsbury, Technojock Software Inc., for the product
  1485.                  Technojock Object Toolkit
  1486.                * Borland International for Borland Pascal v7.0
  1487.                * Last and not least, all the users of Harmony BBS
  1488.                  (607)748-5276 who tested Magview
  1489.  
  1490.           If you are interested in obtaining other shareware products from
  1491.           Concord Software (namely, Harmony BBS (the most recent version),
  1492.           contact the BBS mentioned above.
  1493.  
  1494.           We are also available via Fidonet netmail at the address :
  1495.                             Jasen Fici 1:260/445
  1496.                             (voice) (607) 786-3061
  1497.  
  1498.           All products and companies mentioned in this documentation,
  1499.           including but not limited to MS-DOS and FidoNet, are the
  1500.           copyrights and trademarks of their respective owners.
  1501.  
  1502.                                         -21-
  1503.